Zum Hauptinhalt springen
Version: 5.2

TimeEntry Service

Dieser Service enthält Methoden um mit den Zeiteinträgen von TimePunch zu arbeiten.

AssignTimeEntriesToCustomer

Mit dieser Methode können mehrere Zeiteinträge einem neuen Kunden zugeordnet werden.

void AssignTimeEntriesToCustomer(  
out TpFault fault,
TpAuthentication authentication,
Guid[] timeEntryIds,
Guid customerId);
Needed PermissiontimeEntries@restrictedEdit
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryIdsArray of ids of the time entries that shall be amended.
customerIdNew customer Id that is used to update the time entries.

AssignTimeEntriesToProjects

Mit dieser Methode können mehrere Zeiteinträge einem neuen Projekt zugeordnet werden.

void AssignTimeEntriesToProjects(  
out TpFault fault,
TpAuthentication authentication,
Guid[] timeEntryIds,
Guid projectId,
Guid taskId);
Needed PermissiontimeEntries@restrictedEdit
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryIdsArray of ids of the time entries that shall be amended.
projectIdNew project Id that is used to update the time entries.
taskIdNew task Id that is used to update the time entries.

BatchFilterUpdate

Diese Methode aktualisiert alle öffentlichen sowie privaten Filter in TimePunch.

TpFault BatchFilterUpdate(  
TpAuthentication authentication,
List<TimeEntrySearchDto> privateFilters,
List<TimeEntrySearchDto> publicFilters);
Needed PermissiontimeEntryFilter@manage
NameModifierDescription
authenticationUser authentication
privateFiltersCollection of private filters
publicFiltersCollection of public filters
Return valueFault object if an exception occurs

CheckTimeEntryOverlapping

Diese Methode prüft, ob der übergebene Zeiteintrag bestehende Zeiteinträge beim Speichern überschreiben würde. Damit kann ein ungewolltes überschreiben von Zeiteinträgen verhindert werden.

bool CheckTimeEntryOverlapping(  
out TpFault fault,
TpAuthentication authentication,
TimeEntryDto entryToCheckOverlapping);
Needed PermissiontimeEntries@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
entryToCheckOverlappingTime Entry that shall be checked against the existing time entries in the database.
Return valueReturns true, if the given time entry would harm existing time entries.

CopyTimeEntries

Diese Methode kopiert eine Liste mit Zeiteinträgen und setzt sie an dem übergebenen Datum wieder ein.

void CopyTimeEntries(  
out TpFault fault,
TpAuthentication authentication,
List<TimeEntrySaveDto> entriesToCopy,
DateTime insertAt);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
entriesToCopyList of time entries to copy
insertAtDate from that the time entries shall be inserted.

CreateBreakTimeDummy

Diese Methode erzeugt einen Pausenzeiteintrag. Ein Pausenzeiteintrag wird immer dann benötigt, wenn eine Zeitspanne zwischen dem letzten Zeiteintrag und dem folgenden Zeiteintrag liegt.

TimeEntryDto CreateBreakTimeDummy(  
out TpFault fault,
TpAuthentication authentication,
DateTime startBreak,
DateTime endBreak);
Needed PermissiontimeEntries@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
startBreakStart time of the dummy break entry
endBreakEnd time of the dummy break entry.
Return valueThe created time entry

CreateNewTimeEntry

Diese Methode erzeugt einen neuen Zeiteintrag und liefert ihn zurück. Der Zeiteintrag wird dabei erzeugt, nicht gespeichert. Erst nach dem Aufruf der Speichermethode ist der Eintrag im TimePunch Profil verfügbar.

TimeEntryDto CreateNewTimeEntry(  
out TpFault fault,
TpAuthentication authentication,
DateTime date);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
dateDate that shall be used for creating the new time entry.
Return valueThe created time entry

DeleteTimeEntries

Diese Methode löscht die übergebenen Zeiteinträge aus dem TimePunch Profil. Wichtig ist, dass nur die Zeiteinträge des authentifizierten TimePunch Profils gelöscht werden können.

void DeleteTimeEntries(  
out TpFault fault,
TpAuthentication authentication,
Guid[] timeEntryIds);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryIdsCollection of time entry Ids that shall be deleted.

DeleteTimeEntriesInRange

Diese Methode löscht alle Zeiteinträge im übergebenen Zeitraum für die ausgewählten Mitarbeitenden.

void DeleteTimeEntriesInRange(
out TpFault fault,
TpAuthentication authentication,
DateTime startDate,
DateTime endDate,
Guid[] userIds);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
DateTimestartDateStart date to search for time entries
DateTimeendDateEnd date to search for time entries
Guid[]userIdsList of user ids that is used by the search

DeleteTimeEntryFilter

Diese Methode löscht einen Zeiteintrags-Filter.

TpFault DeleteTimeEntryFilter(  
TpAuthentication authentication,
Guid filterId);
Needed PermissiontimeEntryFilter@manage timeEntryFilter@managePublic
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
filterIdId of the filter that shall be deleted
Return valueFault object if an exception occurs

ImportTimeEntries

Diese Methode import die übergebenen Zeiteinträge. Beim Import werden nicht die IDs sondern die Start -und Endezeiten, sowie die Projekt -und Tätigkeitsnamen berücksichtigt.

void ImportTimeEntries(  
out TpFault fault,
TpAuthentication authentication,
List<TimeEntryDto> rows);
Needed PermissiontimeEntries@restrictedEdit commonTasks@manage projects@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
rowsCollection of time entries to import

LoadTimeEntries

Diese Methode sollte verwendet werden, wenn keine Zeiteinträge gesucht, sondern mit ihren Ids geladen werden sollen.

List<TimeEntryDto> LoadTimeEntries(  
out TpFault fault,
TpAuthentication authentication,
Guid[] timeEntryIds);
Needed PermissiontimeEntries@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryIdsArray of ids of the time entries that shall be loaded.
Return valueReturns the loaded time entries

LoadTimeEntryFilter

Diese Methode lädt einen Zeiteintragfilter mit der entsprechenden ID.

TimeEntrySearchDto LoadTimeEntryFilter(  
out TpFault fault,
TpAuthentication authentication,
Guid timeEntrySearchId);
Needed PermissiontimeEntryFilter@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntrySearchIdId of the time entry filter
Return valueReturns the loaded time entry filter

MarkTimeEntries

Diese Methode markiert die übergebenen Zeiteinträge mit dem entsprechenden Marker in TimePunch.

void MarkTimeEntries(  
out TpFault fault,
TpAuthentication authentication,
List<Guid> selectedIds,
TimeEntryMarkAs markAs)
Needed PermissiontimeEntries@restrictedEdit
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
selectedIdsList of time entry ids to mark
markAsMarker that shall be set for the time entries Paid = 1 Important = 2 Onsite = 4

SaveTimeEntryFilter

Diese Methode speichert einen Zeiteintragsfilter in der Datenbank ab. Das Mapping erfolgt dabei nicht über die ID, sondern über den Namen des Berichtsfilters.

TimeEntrySearchDto SaveTimeEntryFilter(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySearchDto timeEntryFilter);
Needed PermissiontimeEntryFilter@manage timeEntryFilter@managePublic
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryFilterTime Entry Filter so save
Return valueThe stored time entry filter

SearchTimeEntries

Diese Methode sucht Zeiteinträge die dem angegebenen Filter Objekt entsprechen. Dabei wird die Rolle des Principal berücksichtigt und nur dann Daten von anderen TimePunch Profilen zurückgeliefert, wenn der Principal über die entsprechenden Rechte verfügt.

List<TimeEntryDto> SearchTimeEntries(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySearchDto search);
Needed PermissiontimeEntries@access / core@switchIdentity
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
searchThe filter that is used to search the time entries
Return valueCollection containing the found time entries

SearchTimeEntryFilters

Diese Methode sucht Zeiteintragsfilter in der Datenbank anhand der Suchfilter Kriterien. Es wird danach eine Liste mit allen gefunden Zeiteintragsfiltern zurückgeliefert.

List<TimeEntrySearchDto> SearchTimeEntryFilters(  
out TpFault fault,
TpAuthentication authentication,
TimeEntryFilterSearchDto searchFilterCriteria);
Needed PermissiontimeEntryFilter@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
searchFilterCriteriaSearchfilter criteria
Return valueCollection containing the found time entry search objects

SplitTimeEntry

Diese Methode teilt einen bestehenden Zeiteintrag in mehrere Zeiteinträge auf.

void SplitTimeEntry(
out TpFault fault,
TpAuthentication authentication,
Guid timeEntryId,
List<TimeEntrySaveDto> timeEntries,
bool closeActiveTimeEntry);
Needed PermissiontimeEntries@restrictedEdit
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
GuidtimeEntryIdID of the time entry that shall be splitted. That can also be an ID of an active time entry.
TimeEntrySaveDto[]timeEntriesList of time entries that shall replace the time entry specified by it's ID
boolcloseActiveTimeEntryIf the time entry Id specifies an active entry, this flag indicates whether to close the time recording or not

UnmarkTimeEntries

Diese Methode entfernt die Markierungen auf den übergebenen Zeiteinträgen.

void UnmarkTimeEntries(  
out TpFault fault,
TpAuthentication authentication,
List<Guid> selectedIds,
TimeEntryMarkAs markAs);
Needed PermissiontimeEntries@restrictedEdit
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
selectedIdsList of time entry ids to mark
markAsMarker that shall be removed from the time entries Paid = 1 Important = 2 Onsite = 4

UpdateTimeEntryFilter

Diese Methode aktualisiert einen bestehenden Zeiteintragsfilter. Damit die Update Methode aufgerufen werden kann, sollte der zu aktualisierende Zeiteintragsfilter bereits vorhanden sein.

TimeEntrySearchDto UpdateTimeEntryFilter(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySearchDto filter);
Needed PermissiontimeEntryFilter@manage timeEntryFilter@managePublic
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
filterTime Entry Filter so save
Return valueThe stored time entry filter

ValidateAndSaveBreakReplacement

Diese Methode wurde speziell dafür entwickelt auch von Mitarbeitern ohne besondere Rechte verwendet zu werden. Sie wird dazu verwendet, damit bereits vorhandene Pausen, d.h. die Zeit zwischen zwei Zeiteinträgen, von einem Mitarbeiter ohne besondere Rechte belegt werden kann.

TimeEntrySaveResultDto ValidateAndSaveBreakReplacement(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySaveDto timeEntry);
Needed PermissiontimeEntries@restrictedEdit
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryTime entry that shall be stored in the database. The time entry must fit into a break time.
Return valueReturns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveRestrictedTimeEntry

Diese Methode dient zum eingeschränkten editieren eines Zeiteintrags. Diese Methode erlaubt nur das Bearbeiten des Projekts, der Tätigkeit und der Beschreibung. Start, und Endzeiten, sowie die Pause dürfen nicht geändert werden.

TimeEntrySaveResultDto ValidateAndSaveRestrictedTimeEntry(  
out TpFault fault,
TpAuthentication authentication,
TimeEntryRestrictedSaveDto timeEntry);
Needed PermissiontimeEntries@restrictedEdit
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryTime entry that shall be stored in the database.
Return valueReturns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntry

Diese Methode nimmt einen Zeiteintrag entgegen, überprüft ihn auf Korrektheit und speichert dann den Zeiteintrag in der Datenbank ab.

TimeEntrySaveResultDto ValidateAndSaveTimeEntry(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySaveDto timeEntry);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryTime entry that shall be stored in the database.
Return valueReturns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntrySeries

Mit dieser Methode lässt sich eine Serie von Zeiteinträgen anlegen, zum Beispiel um eine Urlaubsbuchung zu realisieren. Benötigt wird das Start –und Enddatum. Die konkreten Anfangszeiten werden über das hinterlegte Arbeitszeitmodell ermittelt.

TimeEntrySaveResultDto ValidateAndSaveTimeEntrySeries(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySeriesDto timeEntrySeries);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntrySeriesTime entry series that shall be stored in the database.
Return valueReturns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntrySeriesMultipleUsers

Mit dieser Methode lässt sich eine Serie von Zeiteinträgen anlegen, zum Beispiel um eine Urlaubsbuchung zu realisieren. Benötigt wird das Start –und Enddatum. Die konkreten Anfangszeiten werden über das hinterlegte Arbeitszeitmodell ermittelt.

TimeEntrySaveResultDto ValidateAndSaveTimeEntrySeriesMultipleUsers(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySeriesDto timeEntrySeries,
Guid[] userIds);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntrySeriesTime entry series that shall be stored in the database.
Guid[]Array of user ids for whom the time entry series shall be created
Return valueReturns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntryCopies

Mit dieser Methode lässt sich ein Zeiteintrag kopiert speichern, zum Beispiel um mehrere Tage hintereinander einen Arbeitszeiteintrag mit festgelegter Start –und Endzeit zu erstellen. Wie zum Beispiel für die Berufsschule benötigt.

TimeEntrySaveResultDto ValidateAndSaveTimeEntryCopies(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySaveDto timeEntry);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryTime entry copy that shall be stored in the database.
Return valueReturns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries

ValidateAndSaveTimeEntryCopiesMultipleUsers

Mit dieser Methode lässt sich ein Zeiteintrag kopiert speichern, zum Beispiel um mehrere Tage hintereinander einen Arbeitszeiteintrag mit festgelegter Start –und Endzeit zu erstellen. Wie zum Beispiel für die Berufsschule benötigt.

TimeEntrySaveResultDto ValidateAndSaveTimeEntryCopiesMultipleUsers(  
out TpFault fault,
TpAuthentication authentication,
TimeEntrySaveDto timeEntry,
Guid[] userIds);
Needed PermissiontimeEntries@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
timeEntryTime entry copy that shall be stored in the database.
Guid[]Array of user ids for whom the time entry copies shall be created
Return valueReturns the result of storing the time entry (Ok, BreakEnforced, EmptyBreakEntry) and the stored time entries